<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    /*<a name="line.1"></a>
<FONT color="green">002</FONT>     * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a>
<FONT color="green">003</FONT>     * contributor license agreements.  See the NOTICE file distributed with<a name="line.3"></a>
<FONT color="green">004</FONT>     * this work for additional information regarding copyright ownership.<a name="line.4"></a>
<FONT color="green">005</FONT>     * The ASF licenses this file to You under the Apache License, Version 2.0<a name="line.5"></a>
<FONT color="green">006</FONT>     * (the "License"); you may not use this file except in compliance with<a name="line.6"></a>
<FONT color="green">007</FONT>     * the License.  You may obtain a copy of the License at<a name="line.7"></a>
<FONT color="green">008</FONT>     *<a name="line.8"></a>
<FONT color="green">009</FONT>     *      http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a>
<FONT color="green">010</FONT>     *<a name="line.10"></a>
<FONT color="green">011</FONT>     * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a>
<FONT color="green">012</FONT>     * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a>
<FONT color="green">013</FONT>     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a>
<FONT color="green">014</FONT>     * See the License for the specific language governing permissions and<a name="line.14"></a>
<FONT color="green">015</FONT>     * limitations under the License.<a name="line.15"></a>
<FONT color="green">016</FONT>     */<a name="line.16"></a>
<FONT color="green">017</FONT>    <a name="line.17"></a>
<FONT color="green">018</FONT>    package org.apache.commons.math.distribution;<a name="line.18"></a>
<FONT color="green">019</FONT>    <a name="line.19"></a>
<FONT color="green">020</FONT>    import java.io.Serializable;<a name="line.20"></a>
<FONT color="green">021</FONT>    <a name="line.21"></a>
<FONT color="green">022</FONT>    import org.apache.commons.math.MathRuntimeException;<a name="line.22"></a>
<FONT color="green">023</FONT>    import org.apache.commons.math.exception.util.LocalizedFormats;<a name="line.23"></a>
<FONT color="green">024</FONT>    import org.apache.commons.math.util.MathUtils;<a name="line.24"></a>
<FONT color="green">025</FONT>    import org.apache.commons.math.util.FastMath;<a name="line.25"></a>
<FONT color="green">026</FONT>    <a name="line.26"></a>
<FONT color="green">027</FONT>    /**<a name="line.27"></a>
<FONT color="green">028</FONT>     * The default implementation of {@link HypergeometricDistribution}.<a name="line.28"></a>
<FONT color="green">029</FONT>     *<a name="line.29"></a>
<FONT color="green">030</FONT>     * @version $Revision: 1054524 $ $Date: 2011-01-03 05:59:18 +0100 (lun. 03 janv. 2011) $<a name="line.30"></a>
<FONT color="green">031</FONT>     */<a name="line.31"></a>
<FONT color="green">032</FONT>    public class HypergeometricDistributionImpl extends AbstractIntegerDistribution<a name="line.32"></a>
<FONT color="green">033</FONT>            implements HypergeometricDistribution, Serializable {<a name="line.33"></a>
<FONT color="green">034</FONT>    <a name="line.34"></a>
<FONT color="green">035</FONT>        /** Serializable version identifier */<a name="line.35"></a>
<FONT color="green">036</FONT>        private static final long serialVersionUID = -436928820673516179L;<a name="line.36"></a>
<FONT color="green">037</FONT>    <a name="line.37"></a>
<FONT color="green">038</FONT>        /** The number of successes in the population. */<a name="line.38"></a>
<FONT color="green">039</FONT>        private int numberOfSuccesses;<a name="line.39"></a>
<FONT color="green">040</FONT>    <a name="line.40"></a>
<FONT color="green">041</FONT>        /** The population size. */<a name="line.41"></a>
<FONT color="green">042</FONT>        private int populationSize;<a name="line.42"></a>
<FONT color="green">043</FONT>    <a name="line.43"></a>
<FONT color="green">044</FONT>        /** The sample size. */<a name="line.44"></a>
<FONT color="green">045</FONT>        private int sampleSize;<a name="line.45"></a>
<FONT color="green">046</FONT>    <a name="line.46"></a>
<FONT color="green">047</FONT>        /**<a name="line.47"></a>
<FONT color="green">048</FONT>         * Construct a new hypergeometric distribution with the given the population<a name="line.48"></a>
<FONT color="green">049</FONT>         * size, the number of successes in the population, and the sample size.<a name="line.49"></a>
<FONT color="green">050</FONT>         *<a name="line.50"></a>
<FONT color="green">051</FONT>         * @param populationSize the population size.<a name="line.51"></a>
<FONT color="green">052</FONT>         * @param numberOfSuccesses number of successes in the population.<a name="line.52"></a>
<FONT color="green">053</FONT>         * @param sampleSize the sample size.<a name="line.53"></a>
<FONT color="green">054</FONT>         */<a name="line.54"></a>
<FONT color="green">055</FONT>        public HypergeometricDistributionImpl(int populationSize,<a name="line.55"></a>
<FONT color="green">056</FONT>                int numberOfSuccesses, int sampleSize) {<a name="line.56"></a>
<FONT color="green">057</FONT>            super();<a name="line.57"></a>
<FONT color="green">058</FONT>            if (numberOfSuccesses &gt; populationSize) {<a name="line.58"></a>
<FONT color="green">059</FONT>                throw MathRuntimeException<a name="line.59"></a>
<FONT color="green">060</FONT>                        .createIllegalArgumentException(<a name="line.60"></a>
<FONT color="green">061</FONT>                                LocalizedFormats.NUMBER_OF_SUCCESS_LARGER_THAN_POPULATION_SIZE,<a name="line.61"></a>
<FONT color="green">062</FONT>                                numberOfSuccesses, populationSize);<a name="line.62"></a>
<FONT color="green">063</FONT>            }<a name="line.63"></a>
<FONT color="green">064</FONT>            if (sampleSize &gt; populationSize) {<a name="line.64"></a>
<FONT color="green">065</FONT>                throw MathRuntimeException<a name="line.65"></a>
<FONT color="green">066</FONT>                        .createIllegalArgumentException(<a name="line.66"></a>
<FONT color="green">067</FONT>                                LocalizedFormats.SAMPLE_SIZE_LARGER_THAN_POPULATION_SIZE,<a name="line.67"></a>
<FONT color="green">068</FONT>                                sampleSize, populationSize);<a name="line.68"></a>
<FONT color="green">069</FONT>            }<a name="line.69"></a>
<FONT color="green">070</FONT>    <a name="line.70"></a>
<FONT color="green">071</FONT>            setPopulationSizeInternal(populationSize);<a name="line.71"></a>
<FONT color="green">072</FONT>            setSampleSizeInternal(sampleSize);<a name="line.72"></a>
<FONT color="green">073</FONT>            setNumberOfSuccessesInternal(numberOfSuccesses);<a name="line.73"></a>
<FONT color="green">074</FONT>        }<a name="line.74"></a>
<FONT color="green">075</FONT>    <a name="line.75"></a>
<FONT color="green">076</FONT>        /**<a name="line.76"></a>
<FONT color="green">077</FONT>         * For this distribution, X, this method returns P(X &amp;le; x).<a name="line.77"></a>
<FONT color="green">078</FONT>         *<a name="line.78"></a>
<FONT color="green">079</FONT>         * @param x the value at which the PDF is evaluated.<a name="line.79"></a>
<FONT color="green">080</FONT>         * @return PDF for this distribution.<a name="line.80"></a>
<FONT color="green">081</FONT>         */<a name="line.81"></a>
<FONT color="green">082</FONT>        @Override<a name="line.82"></a>
<FONT color="green">083</FONT>        public double cumulativeProbability(int x) {<a name="line.83"></a>
<FONT color="green">084</FONT>            double ret;<a name="line.84"></a>
<FONT color="green">085</FONT>    <a name="line.85"></a>
<FONT color="green">086</FONT>            int[] domain = getDomain(populationSize, numberOfSuccesses, sampleSize);<a name="line.86"></a>
<FONT color="green">087</FONT>            if (x &lt; domain[0]) {<a name="line.87"></a>
<FONT color="green">088</FONT>                ret = 0.0;<a name="line.88"></a>
<FONT color="green">089</FONT>            } else if (x &gt;= domain[1]) {<a name="line.89"></a>
<FONT color="green">090</FONT>                ret = 1.0;<a name="line.90"></a>
<FONT color="green">091</FONT>            } else {<a name="line.91"></a>
<FONT color="green">092</FONT>                ret = innerCumulativeProbability(domain[0], x, 1, populationSize,<a name="line.92"></a>
<FONT color="green">093</FONT>                                                 numberOfSuccesses, sampleSize);<a name="line.93"></a>
<FONT color="green">094</FONT>            }<a name="line.94"></a>
<FONT color="green">095</FONT>    <a name="line.95"></a>
<FONT color="green">096</FONT>            return ret;<a name="line.96"></a>
<FONT color="green">097</FONT>        }<a name="line.97"></a>
<FONT color="green">098</FONT>    <a name="line.98"></a>
<FONT color="green">099</FONT>        /**<a name="line.99"></a>
<FONT color="green">100</FONT>         * Return the domain for the given hypergeometric distribution parameters.<a name="line.100"></a>
<FONT color="green">101</FONT>         *<a name="line.101"></a>
<FONT color="green">102</FONT>         * @param n the population size.<a name="line.102"></a>
<FONT color="green">103</FONT>         * @param m number of successes in the population.<a name="line.103"></a>
<FONT color="green">104</FONT>         * @param k the sample size.<a name="line.104"></a>
<FONT color="green">105</FONT>         * @return a two element array containing the lower and upper bounds of the<a name="line.105"></a>
<FONT color="green">106</FONT>         *         hypergeometric distribution.<a name="line.106"></a>
<FONT color="green">107</FONT>         */<a name="line.107"></a>
<FONT color="green">108</FONT>        private int[] getDomain(int n, int m, int k) {<a name="line.108"></a>
<FONT color="green">109</FONT>            return new int[] { getLowerDomain(n, m, k), getUpperDomain(m, k) };<a name="line.109"></a>
<FONT color="green">110</FONT>        }<a name="line.110"></a>
<FONT color="green">111</FONT>    <a name="line.111"></a>
<FONT color="green">112</FONT>        /**<a name="line.112"></a>
<FONT color="green">113</FONT>         * Access the domain value lower bound, based on &lt;code&gt;p&lt;/code&gt;, used to<a name="line.113"></a>
<FONT color="green">114</FONT>         * bracket a PDF root.<a name="line.114"></a>
<FONT color="green">115</FONT>         *<a name="line.115"></a>
<FONT color="green">116</FONT>         * @param p the desired probability for the critical value<a name="line.116"></a>
<FONT color="green">117</FONT>         * @return domain value lower bound, i.e. P(X &amp;lt; &lt;i&gt;lower bound&lt;/i&gt;) &amp;lt;<a name="line.117"></a>
<FONT color="green">118</FONT>         *         &lt;code&gt;p&lt;/code&gt;<a name="line.118"></a>
<FONT color="green">119</FONT>         */<a name="line.119"></a>
<FONT color="green">120</FONT>        @Override<a name="line.120"></a>
<FONT color="green">121</FONT>        protected int getDomainLowerBound(double p) {<a name="line.121"></a>
<FONT color="green">122</FONT>            return getLowerDomain(populationSize, numberOfSuccesses, sampleSize);<a name="line.122"></a>
<FONT color="green">123</FONT>        }<a name="line.123"></a>
<FONT color="green">124</FONT>    <a name="line.124"></a>
<FONT color="green">125</FONT>        /**<a name="line.125"></a>
<FONT color="green">126</FONT>         * Access the domain value upper bound, based on &lt;code&gt;p&lt;/code&gt;, used to<a name="line.126"></a>
<FONT color="green">127</FONT>         * bracket a PDF root.<a name="line.127"></a>
<FONT color="green">128</FONT>         *<a name="line.128"></a>
<FONT color="green">129</FONT>         * @param p the desired probability for the critical value<a name="line.129"></a>
<FONT color="green">130</FONT>         * @return domain value upper bound, i.e. P(X &amp;lt; &lt;i&gt;upper bound&lt;/i&gt;) &amp;gt;<a name="line.130"></a>
<FONT color="green">131</FONT>         *         &lt;code&gt;p&lt;/code&gt;<a name="line.131"></a>
<FONT color="green">132</FONT>         */<a name="line.132"></a>
<FONT color="green">133</FONT>        @Override<a name="line.133"></a>
<FONT color="green">134</FONT>        protected int getDomainUpperBound(double p) {<a name="line.134"></a>
<FONT color="green">135</FONT>            return getUpperDomain(sampleSize, numberOfSuccesses);<a name="line.135"></a>
<FONT color="green">136</FONT>        }<a name="line.136"></a>
<FONT color="green">137</FONT>    <a name="line.137"></a>
<FONT color="green">138</FONT>        /**<a name="line.138"></a>
<FONT color="green">139</FONT>         * Return the lowest domain value for the given hypergeometric distribution<a name="line.139"></a>
<FONT color="green">140</FONT>         * parameters.<a name="line.140"></a>
<FONT color="green">141</FONT>         *<a name="line.141"></a>
<FONT color="green">142</FONT>         * @param n the population size.<a name="line.142"></a>
<FONT color="green">143</FONT>         * @param m number of successes in the population.<a name="line.143"></a>
<FONT color="green">144</FONT>         * @param k the sample size.<a name="line.144"></a>
<FONT color="green">145</FONT>         * @return the lowest domain value of the hypergeometric distribution.<a name="line.145"></a>
<FONT color="green">146</FONT>         */<a name="line.146"></a>
<FONT color="green">147</FONT>        private int getLowerDomain(int n, int m, int k) {<a name="line.147"></a>
<FONT color="green">148</FONT>            return FastMath.max(0, m - (n - k));<a name="line.148"></a>
<FONT color="green">149</FONT>        }<a name="line.149"></a>
<FONT color="green">150</FONT>    <a name="line.150"></a>
<FONT color="green">151</FONT>        /**<a name="line.151"></a>
<FONT color="green">152</FONT>         * Access the number of successes.<a name="line.152"></a>
<FONT color="green">153</FONT>         *<a name="line.153"></a>
<FONT color="green">154</FONT>         * @return the number of successes.<a name="line.154"></a>
<FONT color="green">155</FONT>         */<a name="line.155"></a>
<FONT color="green">156</FONT>        public int getNumberOfSuccesses() {<a name="line.156"></a>
<FONT color="green">157</FONT>            return numberOfSuccesses;<a name="line.157"></a>
<FONT color="green">158</FONT>        }<a name="line.158"></a>
<FONT color="green">159</FONT>    <a name="line.159"></a>
<FONT color="green">160</FONT>        /**<a name="line.160"></a>
<FONT color="green">161</FONT>         * Access the population size.<a name="line.161"></a>
<FONT color="green">162</FONT>         *<a name="line.162"></a>
<FONT color="green">163</FONT>         * @return the population size.<a name="line.163"></a>
<FONT color="green">164</FONT>         */<a name="line.164"></a>
<FONT color="green">165</FONT>        public int getPopulationSize() {<a name="line.165"></a>
<FONT color="green">166</FONT>            return populationSize;<a name="line.166"></a>
<FONT color="green">167</FONT>        }<a name="line.167"></a>
<FONT color="green">168</FONT>    <a name="line.168"></a>
<FONT color="green">169</FONT>        /**<a name="line.169"></a>
<FONT color="green">170</FONT>         * Access the sample size.<a name="line.170"></a>
<FONT color="green">171</FONT>         *<a name="line.171"></a>
<FONT color="green">172</FONT>         * @return the sample size.<a name="line.172"></a>
<FONT color="green">173</FONT>         */<a name="line.173"></a>
<FONT color="green">174</FONT>        public int getSampleSize() {<a name="line.174"></a>
<FONT color="green">175</FONT>            return sampleSize;<a name="line.175"></a>
<FONT color="green">176</FONT>        }<a name="line.176"></a>
<FONT color="green">177</FONT>    <a name="line.177"></a>
<FONT color="green">178</FONT>        /**<a name="line.178"></a>
<FONT color="green">179</FONT>         * Return the highest domain value for the given hypergeometric distribution<a name="line.179"></a>
<FONT color="green">180</FONT>         * parameters.<a name="line.180"></a>
<FONT color="green">181</FONT>         *<a name="line.181"></a>
<FONT color="green">182</FONT>         * @param m number of successes in the population.<a name="line.182"></a>
<FONT color="green">183</FONT>         * @param k the sample size.<a name="line.183"></a>
<FONT color="green">184</FONT>         * @return the highest domain value of the hypergeometric distribution.<a name="line.184"></a>
<FONT color="green">185</FONT>         */<a name="line.185"></a>
<FONT color="green">186</FONT>        private int getUpperDomain(int m, int k) {<a name="line.186"></a>
<FONT color="green">187</FONT>            return FastMath.min(k, m);<a name="line.187"></a>
<FONT color="green">188</FONT>        }<a name="line.188"></a>
<FONT color="green">189</FONT>    <a name="line.189"></a>
<FONT color="green">190</FONT>        /**<a name="line.190"></a>
<FONT color="green">191</FONT>         * For this distribution, X, this method returns P(X = x).<a name="line.191"></a>
<FONT color="green">192</FONT>         *<a name="line.192"></a>
<FONT color="green">193</FONT>         * @param x the value at which the PMF is evaluated.<a name="line.193"></a>
<FONT color="green">194</FONT>         * @return PMF for this distribution.<a name="line.194"></a>
<FONT color="green">195</FONT>         */<a name="line.195"></a>
<FONT color="green">196</FONT>        public double probability(int x) {<a name="line.196"></a>
<FONT color="green">197</FONT>            double ret;<a name="line.197"></a>
<FONT color="green">198</FONT>    <a name="line.198"></a>
<FONT color="green">199</FONT>            int[] domain = getDomain(populationSize, numberOfSuccesses, sampleSize);<a name="line.199"></a>
<FONT color="green">200</FONT>            if (x &lt; domain[0] || x &gt; domain[1]) {<a name="line.200"></a>
<FONT color="green">201</FONT>                ret = 0.0;<a name="line.201"></a>
<FONT color="green">202</FONT>            } else {<a name="line.202"></a>
<FONT color="green">203</FONT>                double p = (double) sampleSize / (double) populationSize;<a name="line.203"></a>
<FONT color="green">204</FONT>                double q = (double) (populationSize - sampleSize) / (double) populationSize;<a name="line.204"></a>
<FONT color="green">205</FONT>                double p1 = SaddlePointExpansion.logBinomialProbability(x,<a name="line.205"></a>
<FONT color="green">206</FONT>                        numberOfSuccesses, p, q);<a name="line.206"></a>
<FONT color="green">207</FONT>                double p2 =<a name="line.207"></a>
<FONT color="green">208</FONT>                    SaddlePointExpansion.logBinomialProbability(sampleSize - x,<a name="line.208"></a>
<FONT color="green">209</FONT>                        populationSize - numberOfSuccesses, p, q);<a name="line.209"></a>
<FONT color="green">210</FONT>                double p3 =<a name="line.210"></a>
<FONT color="green">211</FONT>                    SaddlePointExpansion.logBinomialProbability(sampleSize, populationSize, p, q);<a name="line.211"></a>
<FONT color="green">212</FONT>                ret = FastMath.exp(p1 + p2 - p3);<a name="line.212"></a>
<FONT color="green">213</FONT>            }<a name="line.213"></a>
<FONT color="green">214</FONT>    <a name="line.214"></a>
<FONT color="green">215</FONT>            return ret;<a name="line.215"></a>
<FONT color="green">216</FONT>        }<a name="line.216"></a>
<FONT color="green">217</FONT>    <a name="line.217"></a>
<FONT color="green">218</FONT>        /**<a name="line.218"></a>
<FONT color="green">219</FONT>         * For the distribution, X, defined by the given hypergeometric distribution<a name="line.219"></a>
<FONT color="green">220</FONT>         * parameters, this method returns P(X = x).<a name="line.220"></a>
<FONT color="green">221</FONT>         *<a name="line.221"></a>
<FONT color="green">222</FONT>         * @param n the population size.<a name="line.222"></a>
<FONT color="green">223</FONT>         * @param m number of successes in the population.<a name="line.223"></a>
<FONT color="green">224</FONT>         * @param k the sample size.<a name="line.224"></a>
<FONT color="green">225</FONT>         * @param x the value at which the PMF is evaluated.<a name="line.225"></a>
<FONT color="green">226</FONT>         * @return PMF for the distribution.<a name="line.226"></a>
<FONT color="green">227</FONT>         */<a name="line.227"></a>
<FONT color="green">228</FONT>        private double probability(int n, int m, int k, int x) {<a name="line.228"></a>
<FONT color="green">229</FONT>            return FastMath.exp(MathUtils.binomialCoefficientLog(m, x) +<a name="line.229"></a>
<FONT color="green">230</FONT>                   MathUtils.binomialCoefficientLog(n - m, k - x) -<a name="line.230"></a>
<FONT color="green">231</FONT>                   MathUtils.binomialCoefficientLog(n, k));<a name="line.231"></a>
<FONT color="green">232</FONT>        }<a name="line.232"></a>
<FONT color="green">233</FONT>    <a name="line.233"></a>
<FONT color="green">234</FONT>        /**<a name="line.234"></a>
<FONT color="green">235</FONT>         * Modify the number of successes.<a name="line.235"></a>
<FONT color="green">236</FONT>         *<a name="line.236"></a>
<FONT color="green">237</FONT>         * @param num the new number of successes.<a name="line.237"></a>
<FONT color="green">238</FONT>         * @throws IllegalArgumentException if &lt;code&gt;num&lt;/code&gt; is negative.<a name="line.238"></a>
<FONT color="green">239</FONT>         * @deprecated as of 2.1 (class will become immutable in 3.0)<a name="line.239"></a>
<FONT color="green">240</FONT>         */<a name="line.240"></a>
<FONT color="green">241</FONT>        @Deprecated<a name="line.241"></a>
<FONT color="green">242</FONT>        public void setNumberOfSuccesses(int num) {<a name="line.242"></a>
<FONT color="green">243</FONT>            setNumberOfSuccessesInternal(num);<a name="line.243"></a>
<FONT color="green">244</FONT>        }<a name="line.244"></a>
<FONT color="green">245</FONT>    <a name="line.245"></a>
<FONT color="green">246</FONT>        /**<a name="line.246"></a>
<FONT color="green">247</FONT>         * Modify the number of successes.<a name="line.247"></a>
<FONT color="green">248</FONT>         *<a name="line.248"></a>
<FONT color="green">249</FONT>         * @param num the new number of successes.<a name="line.249"></a>
<FONT color="green">250</FONT>         * @throws IllegalArgumentException if &lt;code&gt;num&lt;/code&gt; is negative.<a name="line.250"></a>
<FONT color="green">251</FONT>         */<a name="line.251"></a>
<FONT color="green">252</FONT>        private void setNumberOfSuccessesInternal(int num) {<a name="line.252"></a>
<FONT color="green">253</FONT>            if (num &lt; 0) {<a name="line.253"></a>
<FONT color="green">254</FONT>                throw MathRuntimeException.createIllegalArgumentException(<a name="line.254"></a>
<FONT color="green">255</FONT>                        LocalizedFormats.NEGATIVE_NUMBER_OF_SUCCESSES, num);<a name="line.255"></a>
<FONT color="green">256</FONT>            }<a name="line.256"></a>
<FONT color="green">257</FONT>            numberOfSuccesses = num;<a name="line.257"></a>
<FONT color="green">258</FONT>        }<a name="line.258"></a>
<FONT color="green">259</FONT>    <a name="line.259"></a>
<FONT color="green">260</FONT>        /**<a name="line.260"></a>
<FONT color="green">261</FONT>         * Modify the population size.<a name="line.261"></a>
<FONT color="green">262</FONT>         *<a name="line.262"></a>
<FONT color="green">263</FONT>         * @param size the new population size.<a name="line.263"></a>
<FONT color="green">264</FONT>         * @throws IllegalArgumentException if &lt;code&gt;size&lt;/code&gt; is not positive.<a name="line.264"></a>
<FONT color="green">265</FONT>         * @deprecated as of 2.1 (class will become immutable in 3.0)<a name="line.265"></a>
<FONT color="green">266</FONT>         */<a name="line.266"></a>
<FONT color="green">267</FONT>        @Deprecated<a name="line.267"></a>
<FONT color="green">268</FONT>        public void setPopulationSize(int size) {<a name="line.268"></a>
<FONT color="green">269</FONT>            setPopulationSizeInternal(size);<a name="line.269"></a>
<FONT color="green">270</FONT>        }<a name="line.270"></a>
<FONT color="green">271</FONT>    <a name="line.271"></a>
<FONT color="green">272</FONT>        /**<a name="line.272"></a>
<FONT color="green">273</FONT>         * Modify the population size.<a name="line.273"></a>
<FONT color="green">274</FONT>         *<a name="line.274"></a>
<FONT color="green">275</FONT>         * @param size the new population size.<a name="line.275"></a>
<FONT color="green">276</FONT>         * @throws IllegalArgumentException if &lt;code&gt;size&lt;/code&gt; is not positive.<a name="line.276"></a>
<FONT color="green">277</FONT>         */<a name="line.277"></a>
<FONT color="green">278</FONT>        private void setPopulationSizeInternal(int size) {<a name="line.278"></a>
<FONT color="green">279</FONT>            if (size &lt;= 0) {<a name="line.279"></a>
<FONT color="green">280</FONT>                throw MathRuntimeException.createIllegalArgumentException(<a name="line.280"></a>
<FONT color="green">281</FONT>                        LocalizedFormats.NOT_POSITIVE_POPULATION_SIZE, size);<a name="line.281"></a>
<FONT color="green">282</FONT>            }<a name="line.282"></a>
<FONT color="green">283</FONT>            populationSize = size;<a name="line.283"></a>
<FONT color="green">284</FONT>        }<a name="line.284"></a>
<FONT color="green">285</FONT>    <a name="line.285"></a>
<FONT color="green">286</FONT>        /**<a name="line.286"></a>
<FONT color="green">287</FONT>         * Modify the sample size.<a name="line.287"></a>
<FONT color="green">288</FONT>         *<a name="line.288"></a>
<FONT color="green">289</FONT>         * @param size the new sample size.<a name="line.289"></a>
<FONT color="green">290</FONT>         * @throws IllegalArgumentException if &lt;code&gt;size&lt;/code&gt; is negative.<a name="line.290"></a>
<FONT color="green">291</FONT>         * @deprecated as of 2.1 (class will become immutable in 3.0)<a name="line.291"></a>
<FONT color="green">292</FONT>         */<a name="line.292"></a>
<FONT color="green">293</FONT>        @Deprecated<a name="line.293"></a>
<FONT color="green">294</FONT>        public void setSampleSize(int size) {<a name="line.294"></a>
<FONT color="green">295</FONT>            setSampleSizeInternal(size);<a name="line.295"></a>
<FONT color="green">296</FONT>        }<a name="line.296"></a>
<FONT color="green">297</FONT>        /**<a name="line.297"></a>
<FONT color="green">298</FONT>         * Modify the sample size.<a name="line.298"></a>
<FONT color="green">299</FONT>         *<a name="line.299"></a>
<FONT color="green">300</FONT>         * @param size the new sample size.<a name="line.300"></a>
<FONT color="green">301</FONT>         * @throws IllegalArgumentException if &lt;code&gt;size&lt;/code&gt; is negative.<a name="line.301"></a>
<FONT color="green">302</FONT>         */<a name="line.302"></a>
<FONT color="green">303</FONT>        private void setSampleSizeInternal(int size) {<a name="line.303"></a>
<FONT color="green">304</FONT>            if (size &lt; 0) {<a name="line.304"></a>
<FONT color="green">305</FONT>                throw MathRuntimeException.createIllegalArgumentException(<a name="line.305"></a>
<FONT color="green">306</FONT>                        LocalizedFormats.NOT_POSITIVE_SAMPLE_SIZE, size);<a name="line.306"></a>
<FONT color="green">307</FONT>            }<a name="line.307"></a>
<FONT color="green">308</FONT>            sampleSize = size;<a name="line.308"></a>
<FONT color="green">309</FONT>        }<a name="line.309"></a>
<FONT color="green">310</FONT>    <a name="line.310"></a>
<FONT color="green">311</FONT>        /**<a name="line.311"></a>
<FONT color="green">312</FONT>         * For this distribution, X, this method returns P(X &amp;ge; x).<a name="line.312"></a>
<FONT color="green">313</FONT>         *<a name="line.313"></a>
<FONT color="green">314</FONT>         * @param x the value at which the CDF is evaluated.<a name="line.314"></a>
<FONT color="green">315</FONT>         * @return upper tail CDF for this distribution.<a name="line.315"></a>
<FONT color="green">316</FONT>         * @since 1.1<a name="line.316"></a>
<FONT color="green">317</FONT>         */<a name="line.317"></a>
<FONT color="green">318</FONT>        public double upperCumulativeProbability(int x) {<a name="line.318"></a>
<FONT color="green">319</FONT>            double ret;<a name="line.319"></a>
<FONT color="green">320</FONT>    <a name="line.320"></a>
<FONT color="green">321</FONT>            final int[] domain = getDomain(populationSize, numberOfSuccesses, sampleSize);<a name="line.321"></a>
<FONT color="green">322</FONT>            if (x &lt; domain[0]) {<a name="line.322"></a>
<FONT color="green">323</FONT>                ret = 1.0;<a name="line.323"></a>
<FONT color="green">324</FONT>            } else if (x &gt; domain[1]) {<a name="line.324"></a>
<FONT color="green">325</FONT>                ret = 0.0;<a name="line.325"></a>
<FONT color="green">326</FONT>            } else {<a name="line.326"></a>
<FONT color="green">327</FONT>                ret = innerCumulativeProbability(domain[1], x, -1, populationSize, numberOfSuccesses, sampleSize);<a name="line.327"></a>
<FONT color="green">328</FONT>            }<a name="line.328"></a>
<FONT color="green">329</FONT>    <a name="line.329"></a>
<FONT color="green">330</FONT>            return ret;<a name="line.330"></a>
<FONT color="green">331</FONT>        }<a name="line.331"></a>
<FONT color="green">332</FONT>    <a name="line.332"></a>
<FONT color="green">333</FONT>        /**<a name="line.333"></a>
<FONT color="green">334</FONT>         * For this distribution, X, this method returns P(x0 &amp;le; X &amp;le; x1). This<a name="line.334"></a>
<FONT color="green">335</FONT>         * probability is computed by summing the point probabilities for the values<a name="line.335"></a>
<FONT color="green">336</FONT>         * x0, x0 + 1, x0 + 2, ..., x1, in the order directed by dx.<a name="line.336"></a>
<FONT color="green">337</FONT>         *<a name="line.337"></a>
<FONT color="green">338</FONT>         * @param x0 the inclusive, lower bound<a name="line.338"></a>
<FONT color="green">339</FONT>         * @param x1 the inclusive, upper bound<a name="line.339"></a>
<FONT color="green">340</FONT>         * @param dx the direction of summation. 1 indicates summing from x0 to x1.<a name="line.340"></a>
<FONT color="green">341</FONT>         *            0 indicates summing from x1 to x0.<a name="line.341"></a>
<FONT color="green">342</FONT>         * @param n the population size.<a name="line.342"></a>
<FONT color="green">343</FONT>         * @param m number of successes in the population.<a name="line.343"></a>
<FONT color="green">344</FONT>         * @param k the sample size.<a name="line.344"></a>
<FONT color="green">345</FONT>         * @return P(x0 &amp;le; X &amp;le; x1).<a name="line.345"></a>
<FONT color="green">346</FONT>         */<a name="line.346"></a>
<FONT color="green">347</FONT>        private double innerCumulativeProbability(int x0, int x1, int dx, int n,<a name="line.347"></a>
<FONT color="green">348</FONT>                int m, int k) {<a name="line.348"></a>
<FONT color="green">349</FONT>            double ret = probability(n, m, k, x0);<a name="line.349"></a>
<FONT color="green">350</FONT>            while (x0 != x1) {<a name="line.350"></a>
<FONT color="green">351</FONT>                x0 += dx;<a name="line.351"></a>
<FONT color="green">352</FONT>                ret += probability(n, m, k, x0);<a name="line.352"></a>
<FONT color="green">353</FONT>            }<a name="line.353"></a>
<FONT color="green">354</FONT>            return ret;<a name="line.354"></a>
<FONT color="green">355</FONT>        }<a name="line.355"></a>
<FONT color="green">356</FONT>    <a name="line.356"></a>
<FONT color="green">357</FONT>        /**<a name="line.357"></a>
<FONT color="green">358</FONT>         * Returns the lower bound for the support for the distribution.<a name="line.358"></a>
<FONT color="green">359</FONT>         *<a name="line.359"></a>
<FONT color="green">360</FONT>         * For population size &lt;code&gt;N&lt;/code&gt;,<a name="line.360"></a>
<FONT color="green">361</FONT>         * number of successes &lt;code&gt;m&lt;/code&gt;, and<a name="line.361"></a>
<FONT color="green">362</FONT>         * sample size &lt;code&gt;n&lt;/code&gt;,<a name="line.362"></a>
<FONT color="green">363</FONT>         * the lower bound of the support is<a name="line.363"></a>
<FONT color="green">364</FONT>         * &lt;code&gt;max(0, n + m - N)&lt;/code&gt;<a name="line.364"></a>
<FONT color="green">365</FONT>         *<a name="line.365"></a>
<FONT color="green">366</FONT>         * @return lower bound of the support<a name="line.366"></a>
<FONT color="green">367</FONT>         * @since 2.2<a name="line.367"></a>
<FONT color="green">368</FONT>         */<a name="line.368"></a>
<FONT color="green">369</FONT>        public int getSupportLowerBound() {<a name="line.369"></a>
<FONT color="green">370</FONT>            return FastMath.max(0,<a name="line.370"></a>
<FONT color="green">371</FONT>                    getSampleSize() + getNumberOfSuccesses() - getPopulationSize());<a name="line.371"></a>
<FONT color="green">372</FONT>        }<a name="line.372"></a>
<FONT color="green">373</FONT>    <a name="line.373"></a>
<FONT color="green">374</FONT>        /**<a name="line.374"></a>
<FONT color="green">375</FONT>         * Returns the upper bound for the support of the distribution.<a name="line.375"></a>
<FONT color="green">376</FONT>         *<a name="line.376"></a>
<FONT color="green">377</FONT>         * For number of successes &lt;code&gt;m&lt;/code&gt; and<a name="line.377"></a>
<FONT color="green">378</FONT>         * sample size &lt;code&gt;n&lt;/code&gt;,<a name="line.378"></a>
<FONT color="green">379</FONT>         * the upper bound of the support is<a name="line.379"></a>
<FONT color="green">380</FONT>         * &lt;code&gt;min(m, n)&lt;/code&gt;<a name="line.380"></a>
<FONT color="green">381</FONT>         *<a name="line.381"></a>
<FONT color="green">382</FONT>         * @return upper bound of the support<a name="line.382"></a>
<FONT color="green">383</FONT>         * @since 2.2<a name="line.383"></a>
<FONT color="green">384</FONT>         */<a name="line.384"></a>
<FONT color="green">385</FONT>        public int getSupportUpperBound() {<a name="line.385"></a>
<FONT color="green">386</FONT>            return FastMath.min(getNumberOfSuccesses(), getSampleSize());<a name="line.386"></a>
<FONT color="green">387</FONT>        }<a name="line.387"></a>
<FONT color="green">388</FONT>    <a name="line.388"></a>
<FONT color="green">389</FONT>        /**<a name="line.389"></a>
<FONT color="green">390</FONT>         * Returns the mean.<a name="line.390"></a>
<FONT color="green">391</FONT>         *<a name="line.391"></a>
<FONT color="green">392</FONT>         * For population size &lt;code&gt;N&lt;/code&gt;,<a name="line.392"></a>
<FONT color="green">393</FONT>         * number of successes &lt;code&gt;m&lt;/code&gt;, and<a name="line.393"></a>
<FONT color="green">394</FONT>         * sample size &lt;code&gt;n&lt;/code&gt;, the mean is<a name="line.394"></a>
<FONT color="green">395</FONT>         * &lt;code&gt;n * m / N&lt;/code&gt;<a name="line.395"></a>
<FONT color="green">396</FONT>         *<a name="line.396"></a>
<FONT color="green">397</FONT>         * @return the mean<a name="line.397"></a>
<FONT color="green">398</FONT>         * @since 2.2<a name="line.398"></a>
<FONT color="green">399</FONT>         */<a name="line.399"></a>
<FONT color="green">400</FONT>        protected double getNumericalMean() {<a name="line.400"></a>
<FONT color="green">401</FONT>            return (double)(getSampleSize() * getNumberOfSuccesses()) / (double)getPopulationSize();<a name="line.401"></a>
<FONT color="green">402</FONT>        }<a name="line.402"></a>
<FONT color="green">403</FONT>    <a name="line.403"></a>
<FONT color="green">404</FONT>        /**<a name="line.404"></a>
<FONT color="green">405</FONT>         * Returns the variance.<a name="line.405"></a>
<FONT color="green">406</FONT>         *<a name="line.406"></a>
<FONT color="green">407</FONT>         * For population size &lt;code&gt;N&lt;/code&gt;,<a name="line.407"></a>
<FONT color="green">408</FONT>         * number of successes &lt;code&gt;m&lt;/code&gt;, and<a name="line.408"></a>
<FONT color="green">409</FONT>         * sample size &lt;code&gt;n&lt;/code&gt;, the variance is<a name="line.409"></a>
<FONT color="green">410</FONT>         * &lt;code&gt;[ n * m * (N - n) * (N - m) ] / [ N^2 * (N - 1) ]&lt;/code&gt;<a name="line.410"></a>
<FONT color="green">411</FONT>         *<a name="line.411"></a>
<FONT color="green">412</FONT>         * @return the variance<a name="line.412"></a>
<FONT color="green">413</FONT>         * @since 2.2<a name="line.413"></a>
<FONT color="green">414</FONT>         */<a name="line.414"></a>
<FONT color="green">415</FONT>        public double getNumericalVariance() {<a name="line.415"></a>
<FONT color="green">416</FONT>            final double N = getPopulationSize();<a name="line.416"></a>
<FONT color="green">417</FONT>            final double m = getNumberOfSuccesses();<a name="line.417"></a>
<FONT color="green">418</FONT>            final double n = getSampleSize();<a name="line.418"></a>
<FONT color="green">419</FONT>            return ( n * m * (N - n) * (N - m) ) / ( (N*N * (N - 1)) );<a name="line.419"></a>
<FONT color="green">420</FONT>        }<a name="line.420"></a>
<FONT color="green">421</FONT>    }<a name="line.421"></a>




























































</PRE>
</BODY>
</HTML>
